docs(readme): modernize quick start eval and fix agentv compare example - #1572
Merged
Conversation
Deploying agentv with
|
| Latest commit: |
d0114d3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4b328def.agentv.pages.dev |
| Branch Preview URL: | https://christso-readme-quickstart-c.agentv.pages.dev |
christso
force-pushed
the
christso/readme-quickstart-cleanup
branch
13 times, most recently
from
June 30, 2026 05:02
268ad9d to
d325172
Compare
christso
force-pushed
the
christso/readme-quickstart-cleanup
branch
5 times, most recently
from
June 30, 2026 06:25
aee1399 to
44529b0
Compare
- Drop test-level `criteria` shorthand in favor of an explicit `rubrics` assertion (rubric scoring under the hood), keeping a representative mix of contains, rubrics, code-grader, and llm-grader assertions. - Add an `experiment:` runtime block to the quick start eval. - Fix the `agentv compare` example: single-source compares targets within one run, which is misleading for the quick start. Show the canonical two-manifest pairwise form to compare two runs (before/after). - Drop VS Code (no longer supported) and Azure OpenAI (not an agent) from the "Any agent" list. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Rename "Output formats" to "Results" and document the run bundle directory structure (.agentv/results/<experiment>/<timestamp>/...), modeled on agent-eval's presentation but using AgentV's own layout. - Expand the TypeScript SDK example so it fully mirrors the quick start YAML eval: same test and the full assertions mix (contains, rubrics, code-grader, llm-grader) plus threshold. - Use canonical array form for the code-grader command. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
christso
force-pushed
the
christso/readme-quickstart-cleanup
branch
from
June 30, 2026 07:23
b40198e to
103cefe
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
name, top-leveltarget, top-levelmodel, andpolicy;experimentremains the result/run concept, not a top-level eval YAML ordefineEval()field.policyexamples toruns,timeout_seconds/timeoutSeconds,threshold, andbudget_usd/budgetUsd, matching PR [codex] Support eval policy config #1576.assertions, including string shorthand pluscontains,code-grader,llm-grader, and threshold usage..agentv/results/<experiment>/<timestamp>/, resolved target identity subfolders such ascopilot-sdk--claude-sonnet-4.6,index.jsonl,summary.json, and per-test artifacts/sidecars.task/totest/for reader-facing terminology; tracked follow-upav-2ac7covers the compatibility-safe code/artifact rename.evaluate()for application-owned runs anddefineEval()for TypeScript eval files that AgentV runs through the normal runner.eval-schema.jsonso explicittype: rubricsaccepts string shorthand criteria, matching runtime parsing and public docs.Verification
bun run generate:schemafrompackages/core.bun run lint.bun test packages/core/test/evaluation/validation/eval-file-schema.test.ts packages/core/test/evaluation/validation/eval-schema-sync.test.ts.bun test packages/core/test/evaluation/loaders/grader-parser.test.ts --test-name-pattern "string shorthand|criteria".EvalFileSchemabefore the later target/policy README guidance update.git diff --checkafter the target/model/policy/workspace-isolation/runs README updates.git diff --checkafter thename+ target/model/policy README correction.result.json,grading.json,metrics.json,timing.json, transcripts, and outputs.Notes
experimentauthoring and acceptsname+target+model+policy.experimentremains the result namespace/run condition concept used by.agentv/results/<experiment>/<timestamp>/, compare, Dashboard, and application-ownedevaluate()calls.task//task_dirtotest//test_diris intentionally tracked separately in Beadav-2ac7because it touches the public artifact contract and readers.